<HTML><HEAD><TITLE>Manpage of ZPOOL-FEATURES</TITLE>
</HEAD><BODY>
<H1>ZPOOL-FEATURES</H1>
Section: File Formats (5)<BR>Updated: Aug 27, 2013<BR>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">DESCRIPTION</A><DD>
<DL>
<DT><A HREF="#lbAD">Identifying features</A><DD>
<DT><A HREF="#lbAE">Feature states</A><DD>
<DT><A HREF="#lbAF">Read-only compatibility</A><DD>
<DT><A HREF="#lbAG">Unsupported features</A><DD>
<DT><A HREF="#lbAH">Feature dependencies</A><DD>
</DL>
<DT><A HREF="#lbAI">FEATURES</A><DD>
<DT><A HREF="#lbAJ">SEE ALSO</A><DD>
</DL>
<HR>
<A HREF="../index.html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

zpool-features - ZFS pool feature descriptions
<A NAME="lbAC">&nbsp;</A>
<H2>DESCRIPTION</H2>

<P>
<P>

ZFS pool on-disk format versions are specified via &quot;features&quot; which replace
the old on-disk format numbers (the last supported on-disk format number is
28). To enable a feature on a pool use the <B>upgrade</B> subcommand of the
<B><A HREF="../man8/zpool.8.html">zpool</A></B>(8) command, or set the <B>feature@</B><I>feature_name</I> property
to <B>enabled</B>.
<P>
<P>

The pool format does not affect file system version compatibility or the ability
to send file systems between pools.
<P>
<P>

Since most features can be enabled independently of each other the on-disk
format of the pool is specified by the set of all features marked as
<B>active</B> on the pool. If the pool was created by another software version
this set may include unsupported features.
<A NAME="lbAD">&nbsp;</A>
<H3>Identifying features</H3>

<P>
<P>

Every feature has a guid of the form <I>com.example:feature_name</I>. The reverse
DNS name ensures that the feature's guid is unique across all ZFS
implementations. When unsupported features are encountered on a pool they will
be identified by their guids. Refer to the documentation for the ZFS
implementation that created the pool for information about those features.
<P>
<P>

Each supported feature also has a short name. By convention a feature's short
name is the portion of its guid which follows the ':' (e.g.
<I>com.example:feature_name</I> would have the short name <I>feature_name</I>),
however a feature's short name may differ across ZFS implementations if
following the convention would result in name conflicts.
<A NAME="lbAE">&nbsp;</A>
<H3>Feature states</H3>

<P>
<P>

Features can be in one of three states:
<P>


<B>active</B>

<DL COMPACT><DT><DD>
This feature's on-disk format changes are in effect on the pool. Support for
this feature is required to import the pool in read-write mode. If this
feature is not read-only compatible, support is also required to import the pool
in read-only mode (see &quot;Read-only compatibility&quot;).
</DL>

<P>
<P>


<B>enabled</B>

<DL COMPACT><DT><DD>
An administrator has marked this feature as enabled on the pool, but the
feature's on-disk format changes have not been made yet. The pool can still be
imported by software that does not support this feature, but changes may be made
to the on-disk format at any time which will move the feature to the
<B>active</B> state. Some features may support returning to the <B>enabled</B>
state after becoming <B>active</B>. See feature-specific documentation for
details.
</DL>

<P>
<P>


<B>disabled</B>

<DL COMPACT><DT><DD>
This feature's on-disk format changes have not been made and will not be made
unless an administrator moves the feature to the <B>enabled</B> state. Features
cannot be disabled once they have been enabled.
</DL>

<P>
<P>
<P>

The state of supported features is exposed through pool properties of the form
<I>feature@short_name</I>.
<A NAME="lbAF">&nbsp;</A>
<H3>Read-only compatibility</H3>

<P>
<P>

Some features may make on-disk format changes that do not interfere with other
software's ability to read from the pool. These features are referred to as
&quot;read-only compatible&quot;. If all unsupported features on a pool are read-only
compatible, the pool can be imported in read-only mode by setting the
<B>readonly</B> property during import (see <B><A HREF="../man8/zpool.8.html">zpool</A></B>(8) for details on
importing pools).
<A NAME="lbAG">&nbsp;</A>
<H3>Unsupported features</H3>

<P>
<P>

For each unsupported feature enabled on an imported pool a pool property
named <I>unsupported@feature_guid</I> will indicate why the import was allowed
despite the unsupported feature. Possible values for this property are:
<P>
<P>


<B>inactive</B>

<DL COMPACT><DT><DD>
The feature is in the <B>enabled</B> state and therefore the pool's on-disk
format is still compatible with software that does not support this feature.
</DL>

<P>
<P>


<B>readonly</B>

<DL COMPACT><DT><DD>
The feature is read-only compatible and the pool has been imported in
read-only mode.
</DL>

<P>
<A NAME="lbAH">&nbsp;</A>
<H3>Feature dependencies</H3>

<P>
<P>

Some features depend on other features being enabled in order to function
properly. Enabling a feature will automatically enable any features it
depends on.
<A NAME="lbAI">&nbsp;</A>
<H2>FEATURES</H2>

<P>
<P>

The following features are supported on this system:
<P>


<B>async_destroy</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:async_destroy<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>yes<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
Destroying a file system requires traversing all of its data in order to
return its used space to the pool. Without <B>async_destroy</B> the file system
is not fully removed until all space has been reclaimed. If the destroy
operation is interrupted by a reboot or power outage the next attempt to open
the pool will need to complete the destroy operation synchronously.
<P>
When <B>async_destroy</B> is enabled the file system's data will be reclaimed
by a background process, allowing the destroy operation to complete without
traversing the entire file system. The background process is able to resume
interrupted destroys after the pool has been opened, eliminating the need
to finish interrupted destroys as part of the open operation. The amount
of space remaining to be reclaimed by the background process is available
through the <B>freeing</B> property.
<P>
This feature is only <B>active</B> while <B>freeing</B> is non-zero.
</DL>

<P>
<P>


<B>empty_bpobj</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:empty_bpobj<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>yes<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
This feature increases the performance of creating and using a large
number of snapshots of a single filesystem or volume, and also reduces
the disk space required.
<P>
When there are many snapshots, each snapshot uses many Block Pointer
Objects (bpobj's) to track blocks associated with that snapshot.
However, in common use cases, most of these bpobj's are empty.  This
feature allows us to create each bpobj on-demand, thus eliminating the
empty bpobjs.
<P>
This feature is <B>active</B> while there are any filesystems, volumes,
or snapshots which were created after enabling this feature.
</DL>

<P>
<P>


<B>filesystem_limits</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.joyent:filesystem_limits<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>yes<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>extensible_dataset<BR></TD></TR>
</TABLE>

<P>
This feature enables filesystem and snapshot limits. These limits can be used
to control how many filesystems and/or snapshots can be created at the point in
the tree on which the limits are set.
<P>
This feature is <B>active</B> once either of the limit properties has been
set on a dataset. Once activated the feature is never deactivated.
</DL>

<P>
<P>


<B>lz4_compress</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>org.illumos:lz4_compress<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>no<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
<B>lz4</B> is a high-performance real-time compression algorithm that
features significantly faster compression and decompression as well as a
higher compression ratio than the older <B>lzjb</B> compression.
Typically, <B>lz4</B> compression is approximately 50% faster on
compressible data and 200% faster on incompressible data than
<B>lzjb</B>. It is also approximately 80% faster on decompression, while
giving approximately 10% better compression ratio.
<P>
When the <B>lz4_compress</B> feature is set to <B>enabled</B>, the
administrator can turn on <B>lz4</B> compression on any dataset on the
pool using the <B><A HREF="../man8/zfs.8.html">zfs</A></B>(8) command. Please note that doing so will
immediately activate the <B>lz4_compress</B> feature on the underlying
pool using the <B><A HREF="../man1M/zfs.1M.html">zfs</A></B>(1M) command. Also, all newly written metadata
will be compressed with <B>lz4</B> algorithm. Since this feature is not
read-only compatible, this operation will render the pool unimportable
on systems without support for the <B>lz4_compress</B> feature. Booting
off of <B>lz4</B>-compressed root pools is supported.
<P>
This feature becomes <B>active</B> as soon as it is enabled and will
never return to being <B>enabled.
</DL>

<P>
<P>


spacemap_histogram</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:spacemap_histogram<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>yes<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
This features allows ZFS to maintain more information about how free space
is organized within the pool. If this feature is <B>enabled</B>, ZFS will
set this feature to <B>active</B> when a new space map object is created or
an existing space map is upgraded to the new format. Once the feature is
<B>active</B>, it will remain in that state until the pool is destroyed.
<P>
</DL>

<P>
<P>


<B>extensible_dataset</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:extensible_dataset<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>no<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
This feature allows more flexible use of internal ZFS data structures,
and exists for other features to depend on.
<P>
This feature will be <B>active</B> when the first dependent feature uses it,
and will be returned to the <B>enabled</B> state when all datasets that use
this feature are destroyed.
<P>
</DL>

<P>
<P>


<B>bookmarks</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:bookmarks<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>yes<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>extensible_dataset<BR></TD></TR>
</TABLE>

<P>
This feature enables use of the <B>zfs bookmark</B> subcommand.
<P>
This feature is <B>active</B> while any bookmarks exist in the pool.
All bookmarks in the pool can be listed by running
<B>zfs list -t bookmark -r </B><I>poolname</I>.
<P>
</DL>

<P>
<P>


<B>enabled_txg</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:enabled_txg<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>yes<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
Once this feature is enabled ZFS records the transaction group number
in which new features are enabled. This has no user-visible impact,
but other features may depend on this feature.
<P>
This feature becomes <B>active</B> as soon as it is enabled and will
never return to being <B>enabled.
<P>
</DL>

<P>
<P>


hole_birth</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:hole_birth<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>no<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>enabled_txg<BR></TD></TR>
</TABLE>

<P>
This feature improves performance of incremental sends (&quot;zfs send -i&quot;)
and receives for objects with many holes. The most common case of
hole-filled objects is zvols.
<P>
An incremental send stream from snapshot <B>A</B> to snapshot <B>B</B>
contains information about every block that changed between <B>A</B> and
<B>B</B>. Blocks which did not change between those snapshots can be
identified and omitted from the stream using a piece of metadata called
the 'block birth time', but birth times are not recorded for holes (blocks
filled only with zeroes). Since holes created after <B>A</B> cannot be
distinguished from holes created before <B>A</B>, information about every
hole in the entire filesystem or zvol is included in the send stream.
<P>
For workloads where holes are rare this is not a problem. However, when
incrementally replicating filesystems or zvols with many holes (for
example a zvol formatted with another filesystem) a lot of time will
be spent sending and receiving unnecessary information about holes that
already exist on the receiving side.
<P>
Once the <B>hole_birth</B> feature has been enabled the block birth times
of all new holes will be recorded. Incremental sends between snapshots
created after this feature is enabled will use this new metadata to avoid
sending information about holes that already exist on the receiving side.
<P>
This feature becomes <B>active</B> as soon as it is enabled and will
never return to being <B>enabled.
<P>
</DL>

<P>
<P>


embedded_data</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>com.delphix:embedded_data<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>no<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>none<BR></TD></TR>
</TABLE>

<P>
This feature improves the performance and compression ratio of
highly-compressible blocks.  Blocks whose contents can compress to 112 bytes
or smaller can take advantage of this feature.
<P>
When this feature is enabled, the contents of highly-compressible blocks are
stored in the block &quot;pointer&quot; itself (a misnomer in this case, as it contains
the compresseed data, rather than a pointer to its location on disk).  Thus
the space of the block (one sector, typically 512 bytes or 4KB) is saved,
and no additional i/o is needed to read and write the data block.
<P>
This feature becomes <B>active</B> as soon as it is enabled and will
never return to being <B>enabled</B>.
<P>
</DL>

<P>
<P>


<B>large_blocks</B>

<DL COMPACT><DT><DD>
<TABLE>
<TR VALIGN=top><TD>GUID</TD><TD>org.open-zfs:large_block<BR></TD></TR>
<TR VALIGN=top><TD>READ-ONLY COMPATIBLE</TD><TD>no<BR></TD></TR>
<TR VALIGN=top><TD>DEPENDENCIES</TD><TD>extensible_dataset<BR></TD></TR>
</TABLE>

<P>
The <B>large_block</B> feature allows the record size on a dataset to be
set larger than 128KB.
<P>
This feature becomes <B>active</B> once a <B>recordsize</B> property has been
set larger than 128KB, and will return to being <B>enabled</B> once all
filesystems that have ever had their recordsize larger than 128KB are destroyed.
</DL>

<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>

<B><A HREF="../man8/zpool.8.html">zpool</A></B>(8)
<P>

</BODY>
</HTML>
